WOLF core
WOLF: A Modular Estimation Framework for Robotics
XXXXXXXXXXXXXXXXXXXXXXXXvoid(0)" frameborder="0" name="MSearchResults" id="MSearchResults">
Public Member Functions | Protected Member Functions | List of all members
wolf::MapBase Class Reference

#include <core/map/map_base.h>

Inheritance diagram for wolf::MapBase:
[legend]

Public Member Functions

 WOLF_MAP_CREATE (MapBase)
 
 ~MapBase () override=default
 
bool hasChildren () const override
 
LandmarkBaseConstPtrList getLandmarkList () const
 
LandmarkBasePtrList getLandmarkList ()
 
LandmarkBaseConstPtr getLandmark (const unsigned int &_id) const
 
LandmarkBasePtr getLandmark (const unsigned int &_id)
 
virtual void load (std::string _map_file_yaml)
 
virtual bool save (std::string _map_file_yaml, const std::string &_map_name="") const
 
virtual void printHeader (int depth, bool factored_by, bool metric, bool state_blocks, std::ostream &stream, std::string _tabs="") const
 
virtual void print (int depth, bool factored_by, bool metric, bool state_blocks, std::ostream &stream=std::cout, std::string _tabs="") const
 
virtual CheckLog localCheck (bool _verbose, std::ostream &_stream, std::string _tabs="") const
 
virtual bool check (CheckLog &_log, bool _verbose, std::ostream &_stream, std::string _tabs="") const
 
- Public Member Functions inherited from wolf::NodeBase
 NodeBase (const std::string &_category, const std::string &_type="Undefined", const std::string &_name="")
 
virtual ~NodeBase ()=default
 
unsigned int nodeId () const
 
std::string getCategory () const
 
std::string getType () const
 
std::string getName () const
 
bool isRemoving () const
 
virtual bool hasChildren () const =0
 
void setType (const std::string &_type)
 
void setName (const std::string &_name)
 
ProblemConstPtr getProblem () const
 
ProblemPtr getProblem ()
 

Protected Member Functions

 MapBase ()
 
 MapBase (const YAML::Node &_params)
 
 MapBase (const std::string &_type, const YAML::Node &_params)
 
virtual LandmarkBasePtr addLandmark (LandmarkBasePtr _landmark_ptr)
 
virtual void removeLandmark (LandmarkBasePtr _landmark_ptr)
 
- Protected Member Functions inherited from wolf::NodeBase
virtual void setProblem (ProblemPtr _prob_ptr)
 

Additional Inherited Members

- Protected Attributes inherited from wolf::NodeBase
ProblemWPtr problem_ptr_
 
unsigned int node_id_
 Node id. It is unique over the whole Wolf Tree. More...
 
std::string node_category_
 Text label identifying the category of node ("SENSOR", "FEATURE", etc) More...
 
std::string node_type_
 Text label identifying the type or subcategory of node ("Pin Hole", "Point 2d", etc) More...
 
std::string node_name_
 
bool is_removing_
 A flag for safely removing nodes from the Wolf tree. See remove(). More...
 

Constructor & Destructor Documentation

◆ MapBase() [1/3]

wolf::MapBase::MapBase ( )
protected

◆ MapBase() [2/3]

wolf::MapBase::MapBase ( const YAML::Node &  _params)
protected

◆ MapBase() [3/3]

wolf::MapBase::MapBase ( const std::string &  _type,
const YAML::Node &  _params 
)
protected

◆ ~MapBase()

wolf::MapBase::~MapBase ( )
overridedefault

Member Function Documentation

◆ addLandmark()

LandmarkBasePtr wolf::MapBase::addLandmark ( LandmarkBasePtr  _landmark_ptr)
protectedvirtual

◆ check()

bool wolf::MapBase::check ( CheckLog &  _log,
bool  _verbose,
std::ostream &  _stream,
std::string  _tabs = "" 
) const
virtual

◆ getLandmark() [1/2]

LandmarkBasePtr wolf::MapBase::getLandmark ( const unsigned int &  _id)

◆ getLandmark() [2/2]

LandmarkBaseConstPtr wolf::MapBase::getLandmark ( const unsigned int &  _id) const

◆ getLandmarkList() [1/2]

LandmarkBasePtrList wolf::MapBase::getLandmarkList ( )
inline

◆ getLandmarkList() [2/2]

LandmarkBaseConstPtrList wolf::MapBase::getLandmarkList ( ) const
inline

◆ hasChildren()

bool wolf::MapBase::hasChildren ( ) const
overridevirtual

Implements wolf::NodeBase.

◆ load()

void wolf::MapBase::load ( std::string  _map_file_yaml)
virtual

◆ localCheck()

CheckLog wolf::MapBase::localCheck ( bool  _verbose,
std::ostream &  _stream,
std::string  _tabs = "" 
) const
virtual

◆ print()

void wolf::MapBase::print ( int  depth,
bool  factored_by,
bool  metric,
bool  state_blocks,
std::ostream &  stream = std::cout,
std::string  _tabs = "" 
) const
virtual

◆ printHeader()

void wolf::MapBase::printHeader ( int  depth,
bool  factored_by,
bool  metric,
bool  state_blocks,
std::ostream &  stream,
std::string  _tabs = "" 
) const
virtual

◆ removeLandmark()

void wolf::MapBase::removeLandmark ( LandmarkBasePtr  _landmark_ptr)
protectedvirtual

◆ save()

bool wolf::MapBase::save ( std::string  _map_file_yaml,
const std::string &  _map_name = "" 
) const
virtual

◆ WOLF_MAP_CREATE()

wolf::MapBase::WOLF_MAP_CREATE ( MapBase  )
The documentation for this class was generated from the following files: